MarkLogic 12 Product Documentation

GET /manage/v2/databases/{id|name}?view=status

Summary

This resource address returns status information for the named database. The database can be identified either by id or name.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

id

name

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

status-properties

The operating characteristics of the database.

This is a complex structure with the following children:

enabled

Database enabled status.

state

The state of the database.

indexing-state

Whether the database attached forests are indexing.

rebalancing-state

Whether the database attached forests are rebalancing.

forests-count

The number of forests for the database.

device-space

The amount of space left on the device.

data-size

The total size of the database on disk.

large-data-size

The total size of the large data on disk.

fast-data-size

The total size of the fast storage on disk.

in-memory-size

The total memory used for the database.

average-forest-size

The average forest size attached to database.

largest-forest-size

The size of largest forest attached to database.

least-remaining-space-forest

The lowest free remaining space size.

merge-count

The maximum number of forests that are merging.

total-merge-size

The total size of active forest merging for the database.

reindex-count

The total number of reindexing forests for the database.

backup-count

The maximum number of forests that are backing up.

last-backup

last-incr-backup

restore-count

The maximum number of forests that are restoring.

min-capacity

The least capacity for a forest as a percentage.

rebalancing

load-properties

The load properties of the database.

This is a complex structure with the following children:

total-load

The sum of the processing load factors in seconds per second.

load-detail

The detailed load characteristics for the database.

This is a complex structure with the following children:

query-read-load

Disk reading time threads spent for a query in proportion to the elapsed time. This is a moving average summed for all of the contributing threads.

journal-write-load

Journal writing time threads spent in proportion to the elapsed time. This is summed for all of the threads writing on the host.

save-write-load

The moving average of time threads spent writing to in-memory stands, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

merge-read-load

Disk read time threads spent during merge, in proportion to the elapsed time. This is summed for all of the contributing threads.

merge-write-load

Disk writing time threads spent for merges, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

backup-read-load

Disk read time threads spent for backup, in proportion to the elapsed time. This is summed for all of the contributing threads.

backup-write-load

Disk writing time threads spent for backups, in proportion to the elapsed time. This is summed for all of the threads writing on the host.

restore-read-load

Disk read time threads spent for restores, in proportion to the elapsed time. This is summed for all of the contributing threads.

restore-write-load

Disk write time threads spent for restores, in proportion to the elasped time. This is summed for all of the threads writing on the host.

large-read-load

Disk read time threads spent on large documents, in proportion to the elapsed time.

large-write-load

Disk write time threads spent for large documents, in proportion to the elapsed time.

database-replication-send-load

Time threads spent sending data for database replication, in proportion to the elapsed time.

database-replication-receive-load

Time threads spent receiving data for database replication, in proportion to the elapsed time.

read-lock-wait-load

Time threads spent waiting to acquire read locks in proportion to the elasped time, summed across all forests on the host.

read-lock-hold-load

Time threads spent holding read locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-wait-load

Time threads spent waiting to acquire write locks in proportion to the elapsed time, summed across all forests on the host.

write-lock-hold-load

Time threads spent holding write locks in proportion to the elapsed time, summed across all forests on the host.

deadlock-wait-load

Time threads spent waiting for locks that eventually result in deadlocks in proportion to the elasped time, summed across all forests on the host.

rate-properties

The rate properties of the database.

This is a complex structure with the following children:

total-rate

The sum of the processing rate factors in seconds per second.

rate-detail

The detailed rate characteristics for the database.

This is a complex structure with the following children:

query-read-rate

The moving average of throughput reading query data from disk, in megabytes per second.

journal-write-rate

The moving average of writing data to the journal, in megabytes per second.

save-write-rate

The moving average of writing data to in-memory stands, in megabytes per second.

merge-read-rate

The moving average throughput of reading merge data from disk, in megabytes per second.

merge-write-rate

The moving average throughput of writing data for merges, in megabytes per second.

backup-read-rate

The moving average throughput of reading backup data from disk, in megabytes per second.

backup-write-rate

The moving average throughput of writing data for backups, in megabytes per second.

restore-read-rate

The moving average throughput of reading restore data from disk, in megabytes per second.

restore-write-rate

The moving average throughput of writing data for restores, in megabytes per second.

large-read-rate

The moving average throughput of reading large documents from disk, in megabytes per second.

large-write-rate

The moving average throughput of writing data for large documents, in megabytes per second.

database-replication-send-rate

The moving average throughput of sending data for database replication, in megabytes per second.

database-replication-receive-rate

The moving average throughput of receiving data for database replication, in megabytes per second.

read-lock-rate

The rate of read lock acquistions, summed across all forests on the host.

write-lock-rate

The rate of write lock acquistions, summed across all forests on the host.

deadlock-rate

The rate of deadlock occurrances, summed across all forests on the host.

cache-properties

The cache properties of the database.

This is a complex structure with the following children:

list-cache-hit-rate

The average number of hits on the list cache.

list-cache-miss-rate

The average number of misses on the list cache.

triple-cache-hit-rate

The average number of hits on the list cache.

triple-cache-miss-rate

The average number of misses on the list cache.

triple-value-cache-hit-rate

The average number of hits on the list cache.

triple-value-cache-miss-rate

The average number of misses on the list cache.

compressed-tree-cache-hit-rate

The average number of hits on the compressed cache.

compressed-tree-cache-miss-rate

The average number of misses on the compressed cache.

list-cache-ratio

triple-cache-ratio

triple-value-cache-ratio

compressed-tree-cache-ratio

large-binary-cache-hit-rate

The average number of hits on the large binary cache.

large-binary-cache-miss-rate

The average number of misses on the large binary cache.

local-disk-failover

The failover properties of the database.

This is a complex structure with the following children:

local-disk-failover-active

Whether the database has failover to forests on the local disk.

replicas

The number of the forests for failover to the local disk.

replica-on-disk-size

The total size on disk of the forests for failover to the local disk.

replica-in-memory-size

The total size in memory of the forests for failover to the local disk.

failed-masters

The total number of replica forests for failover to the local disk.

failed-replicas

The total number of replica forests that are disabled or unmounted.

active-replicas

The total number of forests that are actively replicating for failover to the local disk.

async-replicating

The total number of forests that are async replicating for failover to the local disk.

wait-replication

The total number of forests that are waiting to replicate for failover to the local disk.

database-replication-status

The database replication properties of the database.

This is a complex structure with the following children:

database-replication-configured

Whether database replication is configured.

database-replication-active

Whether all forests are replicating to corresponding forests.

local-forests

Count of local forests

is-foreign-replica

Whether the local forest is a replica of a foreign forest.

foreign-replica-databases

Count of configured foreign replica databases.

foreign-replica-forests

Count of foreign replica forests.

foreign-forests-lag-exceeded

Count of foreign forests where reported lag exceeds configured lag.

shared-disk-failover

The shared disk failover properties of the database.

This is a complex structure with the following children:

shared-disk-failover-active

Whether the database has shared disk failover to forests on shared disk.

flexible-replication-enabled

Whether flexible replication is enabled.

cpf-enabled

Whether CPF (the Content Processing Framework) is enabled.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/databases/Documents?view=status

==> Returns status information on the Documents database.